home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / utility / 601 / animtool / animtool.txt < prev   
Encoding:
Text File  |  1992-01-02  |  10.3 KB  |  212 lines
  1. -------------------------------------------------------------------------
  2. | ANIMTOOL is copyright (c) 1991 by Martin Packer. All rights reserved. |
  3. |                                                                       |
  4. | Permission is granted for unrestriced non-commercial use and          |
  5. | distribution by individuals, public domain libraries and BBS's.       |
  6. | With the condition that it must be accompanied by this file.          |
  7. |                                                                       |
  8. | If you find any bugs, have any suggestions for improvements, feel     |
  9. | the urge to send me large quantities of money, or just want to say    |
  10. | hi! Please write to me:                                               |
  11. |                                                                       |
  12. |         Martin Packer                                                 |
  13. |         81B Preston Road                                              |
  14. |         Brighton                                                      |
  15. |         East Sussex                                                   |
  16. |         U.K.                                                          |
  17. -------------------------------------------------------------------------
  18. ANIMTOOL is a utility for stringing a sequence of low-res image files 
  19. together into an animation. It uses delta compression (only storing the 
  20. differences between frames) to reduce the size and increase the playback 
  21. speed of the animation files it generates.
  22.  
  23. The original command line version of ANIMTOOL came about because I wanted 
  24. to animate some scenes I'd generated using David Buck's DKBTrace Ray-
  25. Tracer. You should find some examples of animated DKBTrace output with 
  26. this program.
  27.  
  28. There are two versions of ANIMTOOL:
  29.  
  30. ANIMTOOL.PRG
  31. Is a version with a nice GEM front-end which allows animations to be 
  32. loaded, played, manipulated in memory and saved.
  33.  
  34. ANIMTOOL.TTP
  35. Is a single pass command line version which can play an animation or 
  36. carry out one of the manipulation operations. Because it only carries out 
  37. one operation at a time (and because the program itself is quite a lot 
  38. smaller), it uses a lot less memory than the GEM version, so it can be 
  39. used to build and play larger animations if memory is getting tight. This 
  40. version can also be renamed ANIMTOOL.PRG and placed in an auto folder, 
  41. where it will attempt to load and play the animation SEQUENCE.TAT in the 
  42. root directory of the boot disk.
  43.  
  44.  
  45.                A Quick Guide to the Features of ANIMTOOL:
  46.  
  47. ANIMTOOL.PRG is controlled from a single full screen dialogue. Here's 
  48. what the various bits mean:
  49.  
  50. Current Animation:
  51.  
  52.      Filename:           The name of the current animation. The default 
  53.                          animation file is SEQUENCE.TAT. When you run 
  54.                          ANIMTOOL this file will be loaded if it exists.
  55.  
  56.      Number of Frames:   The total number of frames in the animation.
  57.  
  58.      Default Speed:      When you load a new animation into ANIMTOOL.PRG, 
  59.                          the playback speed will be set to the 
  60.                          animation's default value. This is also the 
  61.                          speed it will normally run at when played by 
  62.                          ANIMTOOL.TTP.
  63.  
  64.      Repeat:             Animations can be set to repeat indefinitely 
  65.                          when played. This is the default setting which 
  66.                          works in the same way as the default speed.
  67.  
  68.      Load:               Click here to load an animation. If you want to 
  69.                          create a new animation, click here and type the 
  70.                          name into the file selector.
  71.  
  72.      Save:               Click here to save the current animation.
  73.  
  74.      Save As:            Click here to save the current animation with a 
  75.                          different file name.
  76.  
  77.  
  78. Workspace:
  79.  
  80.      When you run ANIMTOOL it will grab the largest chunk of memory it 
  81.      can find to use as its workspace. This tells you how many bytes 
  82.      you've used and how much you've got left.
  83.  
  84.  
  85. Show Frame Info:
  86.  
  87.      A "frame" is actually the stored differences between one screen 
  88.      image in the animation and the next. A frame consists of one or two 
  89.      records. If the two screen palettes differ, the frame will contain a 
  90.      palette record. If the screen images are similar, with no large-
  91.      scale differences, then the frame will contain a delta record, which 
  92.      contains only the differences between the images. If the screen 
  93.      images are too dissimilar for a delta record to be worthwhile, the 
  94.      frame will contain a screen dump record, which contains all 32000 
  95.      bytes of the new screen image. By entering a frame number here, or 
  96.      selecting it using the + and - buttons, and clicking on "Show Frame 
  97.      Info" you can find out which records are present in a frame and how 
  98.      many bytes the frame occupies.
  99.  
  100.  
  101. Play Animation:
  102.  
  103.      Clicking here plays the current animation. Press escape at any time 
  104.      to stop.
  105.  
  106.      Speed:              Selects the playback speed of the animation. The 
  107.                          number here indicates how long each image in the 
  108.                          animation will be displayed for, in VBL's 
  109.                          (vertical blanks - the time taken for the 
  110.                          television/monitor display to be refreshed - on 
  111.                          UK systems, one VBL is 1/50th of a second). With 
  112.                          a complicated animation (where the delta frames 
  113.                          are larger than about 12K) it may not be 
  114.                          possible to play the animation at maximum speed 
  115.                          (1 VBL/frame). It's possible to get an idea of 
  116.                          the maximum playing speed for an animation by 
  117.                          setting the speed to 0. If you do this the 
  118.                          animation will be played at maximum possible 
  119.                          speed without it being sychronised with the 
  120.                          screen refresh. The currently set speed will be 
  121.                          saved as the default speed when you save an 
  122.                          animation.
  123.  
  124.      To Frame:           If a number is entered here the animation will 
  125.                          only play up to the frame indicated. In 
  126.                          combination with "Pause" this lets you isolate 
  127.                          and view a single frame.
  128.  
  129.      Repeat:             If "Yes" is selected the animation will repeat 
  130.                          indefinitely when played. This feature should 
  131.                          only be used if the first frame of the animation 
  132.                          contains a dump record (it usually does). If it 
  133.                          doesn't, strange things will happen because the 
  134.                          animation routines assume that the screen starts 
  135.                          off cleared to colour 0 and the first frame (if 
  136.                          it contains a delta record) will depend on this. 
  137.                          The current repeat state will be saved as the 
  138.                          default when you save an animation.
  139.  
  140.      Pause:              If "Yes" is selected, after playing an 
  141.                          animation, the computer will wait for a keypress 
  142.                          before returning to the control screen.
  143.  
  144.      Step:               If "Yes" is selected, the computer will wait for 
  145.                          a keypress between each frame of the animation.
  146.  
  147.  
  148. Add Degas Image Frame:
  149.  
  150.      Click here to add the indicated degas image to the animation.
  151.  
  152.      FileName:           Click here and select the file containing the 
  153.                          image you want to append to your animation.
  154.  
  155.      Dump Frame:         When "Add Degas Image Frame" is selected, 
  156.                          ANIMTOOL will usually try to generate a delta 
  157.                          record for the new image. You can force a screen 
  158.                          dump record to be generated by selecting this 
  159.                          button.
  160.  
  161.  
  162. Add Loop Frame:
  163.  
  164.      Usually the animation will progress in sequence from one image to 
  165.      the next. This feature allows you to build loops into your 
  166.      animation. Loop frames can be used to repeat short sequences, repeat 
  167.      the whole animation or repeat (effectively pause on) a single frame. 
  168.      A loop frame is the same as any other frame. A delta (or screen 
  169.      dump) record and possibly a palette record must be generated holding 
  170.      the differences between the current last image in the animation and 
  171.      the one you're looping to. Animation loops can be 'nested' inside 
  172.      one another to any depth. The "dump frame" button has the same 
  173.      effect when adding loop frames as with image frames.
  174.  
  175.      Loop To:            Select the frame you wan't to loop back to here.
  176.  
  177.      Loop Count:         Select the number of times the animation should 
  178.                          loop back before continuing. This number should 
  179.                          be one less than the number of times you want 
  180.                          the loop repeated (it will have played once 
  181.                          already). If you enter a count of 0 the looping  
  182.                          will continue indefinitely.
  183.  
  184.  
  185. Delete Last Frame:
  186.  
  187.      Clicking here removes the last frame from the animation.
  188.  
  189.  
  190.  
  191. ANIMTOOL.TTP can do everything that ANIMTOOL.PRG can except deleting the 
  192. last frame. As mentioned earlier, it uses less memory than ANIMTOOL.PRG 
  193. but it can only carry out one operation per pass. So it's a pretty slow 
  194. way to do things if you're loading the animation from a floppy disk each 
  195. time. I usually write a CLI batch file which uses ANIMTOOL.TTP to build 
  196. my animations.
  197.  
  198. Usage: ANIMTOOL <filename> <options>
  199.  
  200. Options:
  201.  
  202.      /H              Display help screen.
  203.      /I<filename>    Degas (PI1) image to append.
  204.      /S<speed>       Playback speed (VBLs/frame).
  205.      +/-R            Repeat/don't repeat animation.
  206.      /L<frame no.>   Append a loop back to this frame
  207.      /C<count>       Used with /L to define the loop count
  208.      /D              Force new frame to be a screen dump
  209.  
  210. If filename is not given the default SEQUENCE.TAT is used.
  211.  
  212.